Class Document

Adiciona um Bookmark no Position especificado à primeira guia ou, para scripts que estejam vinculado a um documento, a guia ativa. Para adicionar um favorito em qualquer guia, use o método DocumentTab.addBookmark(position).

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

}

Parâmetros

Retornar

Bookmark: o novo favorito.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Adiciona o usuário especificado à lista de editores do Document. Se o usuário já estava na lista de visualizadores, esse método promove o usuário para fora da lista de leitores.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Adiciona o usuário especificado à lista de editores do Document. Se o usuário já estava na lista de visualizadores, esse método promove o usuário para fora da lista de leitores.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Adiciona a matriz de usuários especificada à lista de editores do Document. Se algum dos usuários já estavam na lista de visualizadores, este método os promove para fora da lista de os espectadores.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Adiciona uma seção de rodapé, caso não exista, à primeira guia ou, para scripts vinculados a um documento, à guia ativa. Para adicionar um rodapé a qualquer guia, use o método DocumentTab.addFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Retornar

FooterSection: rodapé da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Adiciona uma seção de cabeçalho, se não existir, à primeira guia ou, para scripts vinculados a um documento, à guia ativa. Para adicionar um cabeçalho a qualquer guia, use o método DocumentTab.addHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Retornar

HeaderSection: o cabeçalho da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Adiciona um NamedRange, que é uma Range com um nome e um ID para usar recuperação posterior, na primeira guia ou, para scripts vinculados a um documento, na guia ativa. Para adicionar um NamedRange em qualquer guia, use o método DocumentTab.addNamedRange(name, range). Nomes não são necessariamente único. vários intervalos diferentes no mesmo documento podem ter o mesmo nome, muito como uma classe em HTML. Por outro lado, os IDs são únicos dentro do documento, como um ID em HTML. Depois de adicionar uma NamedRange a um documento, não será possível modificá-la, apenas removê-la.

Qualquer script que acesse o documento pode acessar um NamedRange. Para evitar problemas conflitos entre scripts, considere prefixar nomes de intervalos com uma string exclusiva.

// Creates a named range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

Parâmetros

Retornar

NamedRange — O NamedRange.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Adiciona o usuário especificado à lista de leitores do Document. Se o usuário já estava na lista de editores, esse método não terá efeito.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Adiciona o usuário especificado à lista de leitores do Document. Se o usuário já estava na lista de editores, esse método não terá efeito.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Adiciona a matriz de usuários especificada à lista de leitores para Document. Se algum dos usuários já estavam na lista de editores, este método não terá efeito para eles.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe o Tab ativo no momento do usuário no documento. Um script só pode acessar ativa do usuário que está executando o script e somente se ele estiver vinculado ao documento.

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());

Retornar

Tab: o Tab ativo do usuário ou null se o script não estiver vinculado a o documento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recupera o conteúdo Document atual como um blob do tipo especificado.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

Parâmetros

Retornar

Blob: o documento atual como um blob.

Recupera o conteúdo atual de Document como um blob.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

Retornar

Blob: o documento atual como um blob.

Recupera o Body da primeira guia ou, para scripts vinculados a um documento, o DocumentBodySection da guia ativa. Para acessar o DocumentBodySection de qualquer guia, use o método DocumentTab.getBody().

As guias podem conter diferentes tipos de seções (por exemplo, HeaderSection, FooterSection). A seção ativa de uma guia é o Body.

Os métodos de elemento na Document delegam ao Body ativo.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Retornar

Body: a seção do corpo da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe o Bookmark com o ID fornecido na primeira guia ou, para scripts vinculados a um documento, a guia ativa. Para receber favorito em qualquer guia, use o método DocumentTab.getBookmark(id). Esse método retornará null se esse Bookmark não existir na guia.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the console.
// otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Parâmetros

Retornar

Bookmark: o Bookmark com o ID fornecido. Caso contrário, o Bookmark não inclui null. existe na guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe todos os objetos Bookmark na primeira guia ou, para scripts vinculados a um documento, na guia ativa. Para conferir todos favoritos em qualquer guia, use o método DocumentTab.getBookmarks().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Retornar

Bookmark[]: uma matriz dos objetos Bookmark na guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recupera o cursor do usuário na guia ativa. Um script só pode acessar o cursor do usuário que está executando o script e somente se ele estiver vinculado ao documento.

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Retornar

Position: uma representação do cursor do usuário, ou null se o usuário não tiver uma cursor posicionado na guia ou se o script não estiver vinculado ao documento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe a lista de editores desse Document.

Retornar

User[]: uma matriz de usuários com permissão para edição.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recupera a seção de rodapé da primeira guia ou, para scripts vinculados a um documento, o rodapé da guia ativa. nesta seção. Para acessar a seção de rodapé de qualquer guia, use o método DocumentTab.getFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

Retornar

FooterSection: o rodapé da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recupera todos os elementos Footnote no corpo da primeira guia ou, para scripts vinculados a um documento, o corpo da guia ativa. Para receber todas as notas de rodapé em qualquer guia, use o método DocumentTab.getFootnotes().

As chamadas para getFootnotes causam uma iteração nos elementos da guia. Para guias grandes, evitar chamadas desnecessárias a esse método.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Retornar

Footnote[]: as notas de rodapé da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recupera a seção do cabeçalho da primeira guia ou, para scripts vinculados a um documento, o cabeçalho da guia ativa. nesta seção. Para acessar a seção do cabeçalho de qualquer guia, use o método DocumentTab.getHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

Retornar

HeaderSection: o cabeçalho da guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recupera o identificador exclusivo do documento. O ID do documento é usado com DocumentApp.openById() para abrir uma instância de documento específica.

Retornar

String: o código do documento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Extrai o código de idioma do documento. Esse é o idioma mostrado no campo Arquivo do editor de documentos > idioma, que pode não ser o idioma real do documento.

Retornar

String: o idioma do documento, ou null se não estiver definido.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recupera o título do documento.

Retornar

String: o título do documento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe o NamedRange com o ID fornecido na primeira guia ou, para scripts vinculados a um documento, a guia ativa. Para conseguir NamedRange com o ID fornecido em qualquer guia, use DocumentTab.getNamedRangeById(id). . Esse método retornará null se esse NamedRange não existir na guia. Nomes não são necessariamente exclusivos, mesmo entre guias. vários intervalos diferentes na mesma guia podem compartilham o mesmo nome, assim como uma classe em HTML. Por outro lado, os IDs são exclusivos na guia, como um ID em HTML.

Parâmetros

Retornar

NamedRange: o NamedRange com o ID fornecido, ou null se esse intervalo não existir em guia.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe todos os objetos NamedRange na primeira guia ou, para scripts vinculados a um documento, na guia ativa. Para conferir todos NamedRange em qualquer guia, use o método DocumentTab.getNamedRanges().

Uma NamedRange pode ser acessada por qualquer script que acesse a guia. Para evitar conflitos não intencionais entre scripts, considere prefixar nomes de intervalos com uma string exclusiva.

Retornar

NamedRange[]: uma matriz dos objetos NamedRange na guia, possivelmente incluindo vários intervalos com o mesmo nome.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe todos os objetos NamedRange com o nome fornecido na primeira guia ou, no caso de scripts que estão vinculados a um documento, a guia ativa. Para receber todos os objetos NamedRange em qualquer guia, use o método DocumentTab.getNamedRanges(name). Os nomes não são necessariamente exclusivos, mesmo entre guias. vários intervalos diferentes a mesma guia podem ter o mesmo nome, como uma classe em HTML. Por outro lado, os IDs são exclusivos dentro da guia, como um ID em HTML.

Uma NamedRange pode ser acessada por qualquer script que acesse o documento. Para evitar conflitos não intencionais entre scripts, considere prefixar nomes de intervalos com uma string exclusiva.

Parâmetros

Retornar

NamedRange[]: uma matriz dos objetos NamedRange na guia com o nome determinado.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recupera a seleção do usuário na guia ativa. Um script só pode acessar a seleção do usuário quem está executando o script, e somente se ele estiver vinculado ao documento.

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Retornar

Range: uma representação da seleção do usuário, ou null se o usuário não tiver qualquer item selecionado na guia, se apenas o final de um parágrafo for selecionado, se apenas o final de um parágrafo e uma nova linha são selecionadas ou se o script não estiver vinculado ao documento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe todos os códigos de idioma compatíveis com os arquivos do Documentos Google.

Retornar

String[]: uma matriz de códigos de idioma.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe o Tab com o ID especificado. Esse método retornará null se essa Tab não existir. Pode acessar guias em qualquer nível de aninhamento.

Parâmetros

Retornar

Tab: o Tab com o ID especificado ou null se esse Tab não existir.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe todos os Tabs não aninhados que fazem parte do documento.

As guias podem conter guias secundárias, que são aninhadas dentro de outra. As guias secundárias são acessíveis usando Tab.getChildTabs().

Retornar

Tab[]: a lista de todos os Tabs que fazem parte do documento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recupera o URL para acessar o documento atual.

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

Retornar

String: o URL para acessar o documento atual.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Recebe a lista de leitores e comentadores deste Document.

Retornar

User[]: uma matriz de usuários com permissão de visualização ou comentário.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Cria um novo Position, que é uma referência a um local na guia, em relação a um um elemento específico na primeira guia ou, para scripts vinculados a um documento, a guia ativa. Para criar um Position em relação a um local em qualquer guia, use o DocumentTab.newPosition(element, offset). . O cursor do usuário é representado como Position, entre outros usos.

// Append a paragraph to the active tab, then place the user's cursor after the first word of
// the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parâmetros

Retornar

Position: o novo Position.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Cria um builder usado para construir objetos Range a partir de elementos de guia na primeira guia ou, no caso de scripts vinculados a uma documento, a guia ativa. Para criar um builder usado para construir objetos DocumentRange dos elementos de qualquer guia, use o método DocumentTab.newRange().

// Change the user's selection to a range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Retornar

RangeBuilder: o novo builder.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Remove o usuário especificado da lista de editores do Document. Esse método não bloquear o acesso de usuários a Document se eles pertencerem a uma classe de usuários acesso geral, por exemplo, se o Document for compartilhado com todo o ou se Document estiver em um drive compartilhado que o usuário pode acessar.

Nos arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Remove o usuário especificado da lista de editores do Document. Esse método não bloquear o acesso de usuários a Document se eles pertencerem a uma classe de usuários acesso geral, por exemplo, se o Document for compartilhado com todo o ou se Document estiver em um drive compartilhado que o usuário pode acessar.

Nos arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Remove o usuário especificado da lista de leitores e comentadores do Document. Isso não terá efeito se o usuário for um editor, não um leitor ou comentador. Esse método também não impede que os usuários acessem a Document caso pertençam a uma classe de usuários que ter acesso geral, por exemplo, se o Document for compartilhado com o o domínio inteiro ou se o Document estiver em um drive compartilhado que o usuário possa acessar.

Nos arquivos do Drive, isso também remove o usuário da lista de editores.

Parâmetros

Retornar

Document: este Document para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Remove o usuário especificado da lista de leitores e comentadores do Document. Isso não terá efeito se o usuário for um editor, não um leitor. Esse método também não bloqueia que os usuários acessem a Document caso pertençam a uma classe de usuários com problemas acesso, por exemplo, se o Document for compartilhado com todo o domínio do usuário ou se o Document estiver em um drive compartilhado que o usuário possa acessar.

Nos arquivos do Drive, isso também remove o usuário da lista de editores.

Parâmetros

Retornar

Document: este Document para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Salva o Document atual. Faz com que as atualizações pendentes sejam limpas e aplicadas.

O método saveAndClose() é invocado automaticamente no final da execução do script. para cada Document editável aberto.

Não é possível editar um Document fechado. Usar DocumentApp.openById() para reabrir uma documento fornecido para edição.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Define o Tab selecionado pelo usuário no documento atual para a guia com o ID especificado.

const doc = DocumentApp.getActiveDocument()

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab(TAB_ID);

Parâmetros

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Define o cursor do usuário, com base em um Position. Um script só pode acessar o cursor do elemento usuário que está executando o script e somente se ele estiver vinculado ao documento.

Fornecer um Position de um Tab inativo alterna a guia ativa do usuário.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Define o código de idioma do documento. Esse é o idioma mostrado no campo Arquivo do editor de documentos > idioma, que pode não ser o idioma real do documento. Use getSupportedLanguageCodes() para conferir todos os códigos de idioma válidos.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Define o título do documento.

Parâmetros

Retornar

Document: o documento atual.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Define a seleção do usuário na guia ativa, considerando um Range. Um script só pode acessar a seleção do usuário que está executando o script e somente se ele estiver vinculado ao documento.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the document.
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents